docs: add README and refactor arch #66
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Théo Tchilinguirian <[email protected]>
|
It would be great to add a "## Usage" section (or something like that) to explain how to launch the stack and use it. Each service's documentation should have the necessary information. |
Signed-off-by: Théo Tchilinguirian <[email protected]>
|
Also we need to update each service's abstract in this PR |
|
We could draw inspiration from RiK, the Rust project from previous DOs. (Very similar architecture btw, with a scheduler, controller and agent). |
Signed-off-by: Théo Tchilinguirian <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to add a README for the project, as well as some more documentation to clarify the purpose of the project, and its inner workings.
This is WIP and this PR is a draft that needs rewriting.
@dev-sys-do/do-2023